BaseRenderableSeriesSceneEntity3D<TRenderableSeries,TPoint3DData,TSceneEntity> Class Members
The following tables list the members exposed by BaseRenderableSeriesSceneEntity3D<TRenderableSeries,TPoint3DData,TSceneEntity>.
Protected Constructors
| Name | Description | |
|---|---|---|
 | BaseRenderableSeriesSceneEntity3D<TRenderableSeries,TPoint3DData,TSceneEntity> Constructor | Initializes a new instance of the BaseRenderableSeriesSceneEntity3D<TRenderableSeries,TPoint3DData,TSceneEntity> class. |
Protected Fields
| Name | Description | |
|---|---|---|
 | _nativeEntity | The native entity in the 3D scene. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| _renderableSeries | The wrapped BaseRenderableSeries3D instance that we are drawing |
| Helper | The strategy for dealing with 3D Geometry in the scene for different data schemas |
Public Properties
| Name | Description | |
|---|---|---|
 | Children | Gets the collection of children for this entity. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| EntityId | Gets or sets a unique System.UInt32 identifier for this entity. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| EntityIdProvider | Gets or sets an SciChart.Charting3D.Primitives.IEntityIdProvider which encodes and decodes SciChart.Charting3D.Primitives.VertexIds VertexIds consist of MeshID (object ID) and vertex ID. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| IsDirty | When true, meshes need to be recreated on the next Render Pass (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| IsDisposed | Gets value determining whether the instance has already been disposed. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| IsFinalized | Gets value determining whether the instance has already been finalized. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| IsHitTestVisible | |
| IsVisible | Overridden. Gets or sets whether this entity is visible or not. |
| Parent | Gets or sets the parent SciChart.Charting3D.Primitives.IBaseSceneEntity (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| RequiresSelectionId | Gets a value indicating whether this entity requires a SelectionID. If TRUE (default), then the SciChart.Charting3D.Primitives.IEntityIdProvider.GetEntityId method will be called on setting EntityIdProvider. This selection ID is passed through to the 3D Graphics engine to enable selection, tooltips on the entity. If FALSE, then no entity ID will be set. It will be the default value of System.UInt32.MaxValue. The item will be considered ignored for selection and tooltips. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| RootSceneEntity | Gets the SciChart.Charting3D.IRootSceneEntity at the root of the (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| Viewport3D | Gets the SciChart.Charting3D.IViewport3D instance that hosts this root entity (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
Public Methods
| Name | Description | |
|---|---|---|
 | BeginLines | Begins an Immediate Lines Mesh, which can be used to draw dynamic continuous (Poly) 3D lines on the fly. Accepts System.Single StrokeThickness which defines the stroke thickness in world coordinates for the line (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| BeginLineStrips | Begins an Immediate Lines Mesh, which can be used to draw dynamic disjointed (discontinuous) 3D lines on the fly. Accepts System.Single StrokeThickness which defines the stroke thickness in world coordinates for the line (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| BeginLitMesh | Begins an Immediate Mesh, which can be used to draw dynamic 3D meshes on the fly. Accepts SciChart.Charting3D.Primitives.TSRRenderMode which defines the DirectX primitive type (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| BeginMesh | Begins an Immediate Mesh, which can be used to draw dynamic 3D meshes on the fly. Accepts SciChart.Charting3D.Primitives.TSRRenderMode which defines the DirectX primitive type (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| BeginPoints | Begins an Immediate Points Mesh, which can be used to draw dynamic points (as textures, pixels or 3D models) on the fly. Accepts pointMarker which defines the geometry of the 3D point (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| BeginSolidMesh | Begins an Immediate Solid Mesh, which can be used to draw dynamic 3D planes on the fly. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| ChangeHelper | Changes the Scene Entity Helper: a strategy for dealing with 3D Geometry in the scene for different data schemas |
| GetEntity<T> | Gets the first child entity of type T (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| GetHeightMapIndex | Gets Height Map Index by specified vertex ID value from selection buffer. |
| GetKind | Gets Scene Entity Kind that determines rendering pass during which scene entity has to be rendered. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| GetMetadata | |
| GetSelectionId | Overloaded. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| GetVertexAt | Gets the X,Y,Z Vertex in world-coordinates nearest the Hit-test site specified by HitTestInfo3D |
| GetVertexCoords | Gets the X,Y,Z Vertex coordinate in world-coordinates nearest the Hit-test site specified by HitTestInfo3D |
| HitTest | Performs a HitTest operation, returning the HitTestInfo3D containing the result |
| InvalidateScene | Forces the entire scene to redraw (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| OnAttached | Called immediately after an entity is attached to a parent (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| OnDetached | Called immediately before an entity is detached from a parent (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| OnEngineRestart | Overridden. Called when the D3DEngine Restarts. Meshes and DirectX related objects should be recreated |
| PerformSelection | Overridden. Performs selection on this entity, setting the IsSelected flag to True or False on the specified Vertex Ids |
| Render | Renders this entity with the current scene and render pass data (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| RenderScene | Called when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| RequiresUpTransform | (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| SetRenderPassData | Sets the current SciChart.Charting3D.Primitives.IRenderPassInfo3D, which contains the data needed for this render pass. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| ToSeriesInfo | Converts a HitTestInfo3D struct, containing information about a Hit-Test operation, into a SciChart.Charting3D.Model.ChartData.SeriesInfo3D, which is a viewmodel for tooltips, legends in the SciChart.Charting3D.SciChart3DSurface library |
| Update | Overloaded. Updates this entity with the current scene time (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| UpdateNativeEntity | Updates all the parameters in native entity. |
| UpdateScene | Overridden. Called when the 3D Engine wishes to update the geometry in this element. This is where we need to cache geometry before draw. |
| VisitEntities | Implements the Visitor Pattern, visiting all Child entities (and their children) performing the operation on each one. Use this when you want to set a property on all entities in the scene, or perform a certain function on all entities (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
Protected Methods
| Name | Description | |
|---|---|---|
 | AttachChild | Attaches a SciChart.Charting3D.Primitives.IBaseSceneEntity to the Children collection. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| CacheMeshValidState | |
| CheckMeshIsValid | |
| CreateNativeMeshes | Re-creates all the native 3D meshes from Data |
| DetachChild | Detaches a SciChart.Charting3D.Primitives.IBaseSceneEntity and removes from the Children collection (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| GetBitmap | Creates a System.Windows.Media.Imaging.WriteableBitmap with the given dimensions and fills it using the brush. |
| GetTexture | Creates a SciChart.Charting3D.Texture2D with the given dimensions and fills it using the brush. |
| OnChildEntitiesCollectionChanged | Called when the Children child entities collection changes (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity<TSceneEntity>) |
| UpdateNativeEntityPosition |
Extension Methods
| Name | Description | |
|---|---|---|
 | DebugFinalizer<T> | Notifies that finalizer has been invoked |
| SafeDispose | Checks for null and if not null, calls Dispose |
| ToDoubleArray | Overloaded. Converts an System.IComparable array to double array |
| ToEnumerable<T> | Yields a single item, converting it to System.Collections.IEnumerable. |
| ToStringArray2D<T> |
Public Events
| Name | Description | |
|---|---|---|
 | EngineRestarted | Occurs when the D3DEngine has been restarted |
See Also